<!DOCTYPE html>
<html lang="en">
<head>
  <title>Cheatsheets - Vert.x</title>
  <meta charset="utf-8">
  <meta http-equiv="X-UA-Compatible" content="IE=edge">
  <meta content="width=device-width, initial-scale=1.0" name="viewport">
  <meta content="Vert.x is a tool-kit for building reactive applications on the JVM." name="description">
  <link href="http://vertx.io/stylesheets/docs.css" media="screen" rel="stylesheet">
  <link href="http://vertx.io/stylesheets/font-awesome.min.css" media="screen" rel="stylesheet">
  <link href="http://vertx.io/javascripts/styles/rainbow.min.css" media="screen" rel="stylesheet">
  <!-- IE 6-8 support of HTML 5 elements -->
  <!--[if lt IE 9]>
  <script src="http://static.jboss.org/theme/js/libs/html5/pre3.6/html5.min.js"></script>
  <![endif]-->

  <link rel="apple-touch-icon" sizes="57x57" href="http://vertx.io/assets/favicons/vertx-favicon-7/apple-touch-icon-57x57.png">
  <link rel="apple-touch-icon" sizes="60x60" href="http://vertx.io/assets/favicons/vertx-favicon-7/apple-touch-icon-60x60.png">
  <link rel="apple-touch-icon" sizes="72x72" href="http://vertx.io/assets/favicons/vertx-favicon-7/apple-touch-icon-72x72.png">
  <link rel="apple-touch-icon" sizes="76x76" href="http://vertx.io/assets/favicons/vertx-favicon-7/apple-touch-icon-76x76.png">
  <link rel="apple-touch-icon" sizes="114x114" href="http://vertx.io/assets/favicons/vertx-favicon-7/apple-touch-icon-114x114.png">
  <link rel="apple-touch-icon" sizes="120x120" href="http://vertx.io/assets/favicons/vertx-favicon-7/apple-touch-icon-120x120.png">
  <link rel="apple-touch-icon" sizes="144x144" href="http://vertx.io/assets/favicons/vertx-favicon-7/apple-touch-icon-144x144.png">
  <link rel="apple-touch-icon" sizes="152x152" href="http://vertx.io/assets/favicons/vertx-favicon-7/apple-touch-icon-152x152.png">
  <link rel="apple-touch-icon" sizes="180x180" href="http://vertx.io/assets/favicons/vertx-favicon-7/apple-touch-icon-180x180.png">
  <link rel="icon" type="image/png" href="http://vertx.io/assets/favicons/vertx-favicon-7/favicon-32x32.png" sizes="32x32">
  <link rel="icon" type="image/png" href="http://vertx.io/assets/favicons/vertx-favicon-7/android-chrome-192x192.png" sizes="192x192">
  <link rel="icon" type="image/png" href="http://vertx.io/assets/favicons/vertx-favicon-7/favicon-96x96.png" sizes="96x96">
  <link rel="icon" type="image/png" href="http://vertx.io/assets/favicons/vertx-favicon-7/favicon-16x16.png" sizes="16x16">
  <link rel="manifest" href="http://vertx.io/assets/favicons/vertx-favicon-7/manifest.json">
  <link rel="mask-icon" href="http://vertx.io/assets/favicons/vertx-favicon-7/safari-pinned-tab.svg" color="#5bbad5">
  <meta name="msapplication-TileColor" content="#7d3194">
  <meta name="msapplication-TileImage" content="http://vertx.io/assets/favicons/vertx-favicon-7/mstile-144x144.png">
  <meta name="theme-color" content="#ffffff">

  <link href="http://fonts.googleapis.com/css?family=Ubuntu:400,500,700,400italic" rel="stylesheet" type="text/css">
  <link rel="alternate" type="application/rss+xml" title="RSS"
     href="http://vertx.io/feed.xml">
  <script>
    (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
      (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
      m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
    })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
    ga('create', 'UA-30144458-1', 'auto');
    ga('create', 'UA-71153120-1', 'auto', 'tracker');
    ga('send', 'pageview');
    ga('tracker.send', 'pageview');
  </script>
</head>
<body>

<a href="http://www.reactivemanifesto.org/" id="reactive-manifesto-banner">
  <img style="border: 0; position: fixed; right: 0; top:0; z-index: 9000"
    src="http://d379ifj7s9wntv.cloudfront.net/reactivemanifesto/images/ribbons/we-are-reactive-black-right.png">
</a>

<a id="skippy" class="sr-only sr-only-focusable" href="#content"><div class="container"><span class="skiplink-text">Skip to main content</span></div></a>

<header class="navbar navbar-default navbar-static-top" id="top" role="banner">
  <div class="container">
    <div class="navbar-header">
      <button class="navbar-toggle collapsed" type="button" data-toggle="collapse" data-target="#vertx-navbar-collapse">
        <span class="sr-only">Toggle navigation</span>
        <span class="icon-bar"></span>
        <span class="icon-bar"></span>
        <span class="icon-bar"></span>
      </button>
      <a href="http://vertx.io/" class="navbar-brand"><img alt="Brand" src="http://vertx.io/assets/logo-sm.png"></a>
    </div>
    <nav class="collapse navbar-collapse" id="vertx-navbar-collapse">
      <ul class="nav navbar-nav navbar-right">
        <li><a href="http://vertx.io/download/">Download</a></li>
        <li><a href="http://vertx.io/docs/">Documentation</a></li>
        <li><a href="https://github.com/vert-x3/wiki/wiki">Wiki</a></li>
        <li><a href="http://vertx.io/community/">Community</a></li>
        <li><a href="http://vertx.io/materials/">Materials</a></li>
        <li><a href="http://vertx.io/blog/">Blog</a></li>        
      </ul>
    </nav>
  </div>
</header>



  <div class="page-header" id="content">
    <div class="container">
      <div class="row">
        <div class="col-sm-12">
          <h1>Cheatsheets</h1>
          
        </div>
      </div>
    </div>
  </div>




<div id="content">
  <div class="container docs-content">
    <div class="row">
      <div class="col-sm-12 col-md-push-9 col-md-3 hidden-xs hidden-sm">
        <div id="sidebar" data-spy="affix">
          <ul class="sectlevel1">
<li><a href="#FindOptions">FindOptions</a></li>
<li><a href="#IndexOptions">IndexOptions</a></li>
<li><a href="#MongoClientDeleteResult">MongoClientDeleteResult</a></li>
<li><a href="#MongoClientUpdateResult">MongoClientUpdateResult</a></li>
<li><a href="#UpdateOptions">UpdateOptions</a></li>
</ul>
        </div>
      </div>
      <div class="col-sm-12 col-md-pull-3 col-md-9">
        <div class="toc hidden-md hidden-lg">
          <h2>Table of Contents</h2>
          <ul class="sectlevel1">
<li><a href="#FindOptions">FindOptions</a></li>
<li><a href="#IndexOptions">IndexOptions</a></li>
<li><a href="#MongoClientDeleteResult">MongoClientDeleteResult</a></li>
<li><a href="#MongoClientUpdateResult">MongoClientUpdateResult</a></li>
<li><a href="#UpdateOptions">UpdateOptions</a></li>
</ul>
        </div>
        <div class="sect1">
<h2 id="FindOptions">FindOptions</h2>
<div class="sectionbody">
 Options used to configure find operations.
<hr>
<table class="tableblock frame-topbot grid-all spread">
<colgroup>
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 50%;">
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-center valign-top"><p class="tableblock">Name</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">Type</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">Description</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="fields"></a><code>fields</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Json object</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the fields</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="limit"></a><code>limit</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the limit</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="skip"></a><code>skip</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (int)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the skip</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="sort"></a><code>sort</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Json object</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the sort document</p></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="sect1">
<h2 id="IndexOptions">IndexOptions</h2>
<div class="sectionbody">
 Options used to configure index.
<hr>
<table class="tableblock frame-topbot grid-all spread">
<colgroup>
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 50%;">
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-center valign-top"><p class="tableblock">Name</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">Type</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">Description</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="background"></a><code>background</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Create the index in the background</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="bits"></a><code>bits</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (Integer)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Gets the number of precision of the stored geohash value of the location data in 2d indexes.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="bucketSize"></a><code>bucketSize</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (Double)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Gets the specified the number of units within which to group the location values for geoHaystack Indexes</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="defaultLanguage"></a><code>defaultLanguage</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>String</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Gets the language for a text index.
</p><p class="tableblock"> <p>The language that determines the list of stop words and the rules for the stemmer and tokenizer.</p></p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="languageOverride"></a><code>languageOverride</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>String</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Gets the name of the field that contains the language string.
</p><p class="tableblock"> <p>For text indexes, the name of the field, in the collection's documents, that contains the override language for the document.</p></p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="max"></a><code>max</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (Double)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Gets the upper inclusive boundary for the longitude and latitude values for 2d indexes..</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="min"></a><code>min</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (Double)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Gets the lower inclusive boundary for the longitude and latitude values for 2d indexes..</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="name"></a><code>name</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>String</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Gets the name of the index.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="partialFilterExpression"></a><code>partialFilterExpression</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Json object</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Get the filter expression for the documents to be included in the index or null if not set</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="sparse"></a><code>sparse</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, the index only references documents with the specified field</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="sphereVersion"></a><code>sphereVersion</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (Integer)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Gets the 2dsphere index version number.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="storageEngine"></a><code>storageEngine</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Json object</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Gets the storage engine options document for this index.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="textVersion"></a><code>textVersion</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (Integer)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The text index version number.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="unique"></a><code>unique</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Gets if the index should be unique.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="version"></a><code>version</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (Integer)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Gets the index version number.</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="weights"></a><code>weights</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Json object</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Gets the weighting object for use with a text index
</p><p class="tableblock"> <p>A document that represents field and weight pairs. The weight is an integer ranging from 1 to 99,999 and denotes the significance
 of the field relative to the other indexed fields in terms of the score.</p></p></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="sect1">
<h2 id="MongoClientDeleteResult">MongoClientDeleteResult</h2>
<div class="sectionbody">
 Result propagated from mongodb driver delete result.
<hr>
<table class="tableblock frame-topbot grid-all spread">
<colgroup>
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 50%;">
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-center valign-top"><p class="tableblock">Name</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">Type</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">Description</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="removedCount"></a><code>removedCount</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (long)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Get the number of removed documents</p></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="sect1">
<h2 id="MongoClientUpdateResult">MongoClientUpdateResult</h2>
<div class="sectionbody">
 Result propagated from mongodb driver update result.
<hr>
<table class="tableblock frame-topbot grid-all spread">
<colgroup>
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 50%;">
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-center valign-top"><p class="tableblock">Name</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">Type</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">Description</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="docMatched"></a><code>docMatched</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (long)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Get the number of documents that're matched</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="docModified"></a><code>docModified</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Number (long)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Get the number of documents that're modified</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="docUpsertedId"></a><code>docUpsertedId</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Json object</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Get the document id that's upserted</p></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="sect1">
<h2 id="UpdateOptions">UpdateOptions</h2>
<div class="sectionbody">
 Options for configuring updates.
<hr>
<table class="tableblock frame-topbot grid-all spread">
<colgroup>
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 50%;">
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-center valign-top"><p class="tableblock">Name</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">Type</p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock">Description</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="multi"></a><code>multi</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set whether multi is enabled</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="upsert"></a><code>upsert</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set whether upsert is enabled</p></td>
</tr>
<tr>
<td class="tableblock halign-right valign-top"><p class="tableblock"><a id="writeOption"></a><code>writeOption</code></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code><a href="enums.html#WriteOption">WriteOption</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set the write option</p></td>
</tr>
</tbody>
</table>
</div>
</div>

        

        
          <div id="footer">
            <div id="footer-text">
              
                Last updated 2016-09-12 08:38:04 CEST
              
              
            </div>
          </div>
        
      </div>
    </div>
  </div>
</div>

<footer>
  <div class="container">
    <div class="row">
      <div class="col-xs-6 col-sm-3 col-md-3 col-lg-2">
        <h2>Vert.x</h2>
        <ul class="list-unstyled">
          <li><a href="http://vertx.io/">Home</a></li>
          <li><a href="http://vertx.io/download/">Download</a></li>
          <li><a href="http://vertx.io/docs/">Documentation</a></li>
          <li><a href="https://github.com/vert-x3/wiki/wiki">Wiki</a></li>
          <li><a href="http://vertx.io/blog/">Blog</a></li>
          <li><a href="http://vertx.io/vertx2/" class="vertx-2-link">Vert.x 2</a></li>
        </ul>
      </div>
      <div class="col-xs-6 col-sm-3 col-md-3 col-lg-2">
        <h2>Community</h2>
        <ul class="list-unstyled">
          <li><a href="http://vertx.io/community/">Help &amp; Contributors</a></li>
          <li><a href="http://vertx.io/materials/">Learning materials</a></li>
          <li><a href="https://groups.google.com/forum/?fromgroups#!forum/vertx">User Group</a></li>
          <li><a href="https://groups.google.com/forum/?fromgroups#!forum/vertx-dev">Developer Group</a></li>
        </ul>
      </div>

      <div class="col-xs-12 col-sm-6 col-lg-offset-2 col-md-6 copyright">
        <p>Vert.x is open source and dual licensed under the <a href="https://www.eclipse.org/org/documents/epl-v10.php">Eclipse Public License 1.0</a> and <a href="https://www.apache.org/licenses/LICENSE-2.0.html">Apache License 2.0</a>.</p>
        <p>This website is licensed under the <a href="http://creativecommons.org/licenses/by-sa/3.0/">CC BY-SA 3.0 License</a>.<br>
        Design by <a href="http://www.michel-kraemer.com">Michel Kr&auml;mer</a>. <a href="http://www.entypo.com">Entypo pictograms</a> by Daniel Bruce.</p>
        <div class="row">
          <div class="col-xs-12 col-lg-offset-1 col-md-5">
            <a href="http://eclipse.org">
            <img class="logo eclipse-logo" src="http://vertx.io/assets/eclipse_logo_grey_small.png" width="204" height="48">
            </a>
          </div>
          <div class="col-xs-12 col-md-offset-2 col-lg-offset-0 col-md-5">
            <a href="http://cloudbees.com">
            <img class="logo cloudbees-logo" src="http://vertx.io/assets/Button-Built-on-CB-1-grey.png" width="180" height="48">
           </a>
          </div>
          <div class="col-xs-12 col-md-offset-2 col-lg-offset-1 col-md-5 jprofiler">
            <a href="http://www.ej-technologies.com/products/jprofiler/overview.html"
            style="text-decoration:none">
            <img class="logo jprofiler-logo" src="http://vertx.io/assets/jprofiler-logo.png" width="48" height="48"><span class="jprofiler-logo">&nbsp; JPROFILER</span>
            </a>
          </div>
        </div>
      </div>
    </div>
  </div>
</footer>

<script src="http://static.jboss.org/theme/js/libs/jquery/jquery-1.9.1.min.js"></script>
<script src="http://vertx.io/javascripts/bootstrap.min.js"></script>
<script src="http://vertx.io/javascripts/highlight.pack.js"></script>
<script>hljs.initHighlightingOnLoad();</script>



<script src="http://vertx.io/javascripts/sidebar.js"></script>


</body>
</html>
